home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / exp16l.zip / EXP16LAN.DOC < prev    next >
Text File  |  1992-06-12  |  14KB  |  377 lines
  1.     AI-LANBIOS Low-level Driver for the Intel EtherExpress 16(tm) Adapter 
  2.                   (EXP16LAN.DOC)
  3.        -----------------------------------------------------
  4.              (C) Copyright 1992 ARTISOFT, Inc.
  5.          Portions Coyright 1992 Intel Corporation
  6.  
  7. Introduction
  8. ============
  9.  
  10. The EXP16LAN low-level AI-LANBIOS driver for Intel's EtherExpress 16 ethernet
  11. adapter was developed by Intel Corp. in conformance with the specifications 
  12. outlined in the Artisoft AI-LANBIOS Driver Development Program.  The 
  13. low-level driver interfaces directly to the network hardware and
  14. provides basic unreliable data transfer capabilities.  The AI-LANBIOS
  15. high-level driver provides the reliable data transfer capabilities
  16. including all NETBIOS functions.
  17.  
  18. The EXP16LAN driver makes extensive use of the on-board memory of the 
  19. EtherExpress 16 board to improve network throughput.
  20.  
  21. NOTE:   For performance and compatibility reasons, the EXP16LAN driver 
  22.     is an I/O mapped-only version for the EtherExpress 16 adapter.  
  23.     This means that even if you have your adapter configured to run 
  24.     in memory mapped mode, the driver will ignore those settings and 
  25.     run in I/O mapped mode.
  26.  
  27. Compatibility Statement
  28. =======================
  29.  
  30. Version 2.01 of EXP16LAN is compatible with Artisoft's LANtastic/AI Network
  31. Operating System v4.1, except for the following functional considerations:
  32.     - Frequent disconnects are encountered when trying to configure 
  33.         multiple adapters on 1 node.
  34. In addition, the EXP16LAN driver does not accept IRQ as a command line 
  35. switch because the settings on the card is solely controlled by Intel's
  36. SOFTSET program.
  37.  
  38. Vendor Information
  39. ==================
  40.  
  41. Intel Personal Computer Enhancement Division.  5200, N.E. Elam Young Pkwy.
  42. Hillsboro  OR 97124-6497.  Tech Support Phone Number: 503-629-7576.
  43.  
  44. Running EXP16LAN
  45. ================
  46.  
  47. Before running the EXP16LAN driver, configure your EtherExpress board by
  48. running the SOFTSET program that is contained on the driver disk that came
  49. with your EtherExpress board.
  50.  
  51. The EXP16LAN low-level driver must be run before the AI-LANBIOS.  The
  52. EXP16LAN driver interfaces to the AI-LANBIOS using a DOS multiplex
  53. interrupt number.  The default multiplex number is C7.  If you are only
  54. running one low-level driver and one copy of AI-LANBIOS then you will
  55. not have to worry about which multiplex number to assign.  Multiplex
  56. numbers 00 through BF are reserved for DOS use so you must use a multiplex
  57. number between C0 through FF.
  58. * Warning: Testing results showed that frequent disconnects were encountered
  59. when trying to configure multiple adapters (and invocations of EXP16LAN.EXE
  60. v2.01) on a single node.  See Compatibility Statement above. *
  61.  
  62. Each invocation of the EXP16LAN driver supports one Intel EtherExpress 16 
  63. adapter board.  You must run multiple copies of EXP16LAN if you have multiple 
  64. cards installed in your computer.  For each invocation of EXP16LAN you must 
  65. run a separate invocation of the AI-LANBIOS program.  When running multiple
  66. invocations of the EXP16LAN driver each invocation must have a unique
  67. multiplex number and I/O base address.
  68.  
  69. The EXP16LAN low-level driver program name is EXP16LAN.EXE.  The syntax for
  70. EXP16LAN is
  71.  
  72.      EXP16LAN[switches . . . ] [ ; comment]
  73.  
  74. where [switches . . . ] denotes zero or more optional command line switches. 
  75. Switches may be delimited by blanks or slashes (/).  If a switch takes a
  76. value, the switch must be followed by an equal sign (=) or a colon (:).
  77. Some values may be hexadecimal numbers while other values may be decimal.
  78. All switch values are range checked and illegal values produce errors.
  79.  
  80. You may place a comment on the command line by preceding the comment with
  81. a semicolon (;).  You must precede the comment character with a blank.
  82.  
  83. The valid switch formats are:
  84.  
  85.      SWITCH
  86.      SWITCH:value
  87.      /SWITCH
  88.      /SWITCH=value
  89.      @file
  90.  
  91. The valid EXP16LAN switches are enumerated below.  The letters "ddd"
  92. denote a decimal number.  The letters "hh" denote a hexadecimal number. 
  93. Values enclosed in [] indicate default values if the switch is omitted. 
  94. Values after [] denote the valid range of the switch. 
  95.  
  96. ----------
  97.     @switch-file
  98.  
  99. This option specifies that further switches are to be taken from an
  100. switch file.  Any switches after the @switch-file name will be used,
  101. and the switch settings take precedence over any settings in the switch
  102. file.  You may invoke switch files from within switch files as often as
  103. you wish.  The file should contain valid switches and may contain comment
  104. characters (;) at the beginning of each line or after switches.
  105.  
  106. For example,
  107.  
  108.     EXP16LAN @setup
  109.  
  110. The file SETUP contains
  111.  
  112.     ; EXP16LAN AI-LANBIOS driver setup file
  113.  
  114.     IOBASE=310            ; Use I/O address 310
  115.     verbose               ; Display verbose information
  116.  
  117. ----------
  118.     HELP or ?
  119.  
  120. This switch displays information about the valid command line switches,
  121. but does not install the EXP16LAN driver.  For example,
  122.  
  123.     EXP16LAN/help
  124.     EXP16LAN ?
  125.  
  126. See the messages section for a detailed description of the HELP display
  127. output.
  128.  
  129. ----------
  130.     IOBASE=hhhh [300] 200, 210, 220, 230, 240, 250, 260, 270,
  131.               300, 310, 320, 330, 340, 350, 360, 370
  132.  
  133. This switch specifies the I/O base address configured on the EtherExpress 16 card.
  134. The IOBASE switch value must match the value stored in the card's EEPROM.  
  135. The default value is the same as the default factory setting on the cards.
  136.  
  137. Unless you have more than one EtherExpress board installed in your computer,
  138. the IOBASE switch is unnecessary, as the driver can find and initialize 
  139. the board.
  140.  
  141. To set the I/O base address on the card, run Intel's SOFTSET program.
  142.  
  143. ----------
  144.     MPX=hh [C7] C0-FF
  145.  
  146. This switch specifies the multiplex (MPX) interrupt number to use for
  147. communication to the high-level AI-LANBIOS.  You will need to change this
  148. value only if the MPX number is in use by another application or low-level
  149. driver.
  150.  
  151. ----------
  152.     PACKET_SIZE=dddd [1500] 570-1500
  153.  
  154. This switch specifies the maximum size of transmitted IEEE 802.3 packets.
  155. You may need to change this value when using certain bridges that do not
  156. support the full 1500 byte packet size.  Even when you reduce the packet
  157. size, the low-level driver can still receive large packets.
  158.  
  159. ----------
  160.     REMOVE
  161.  
  162. This switch removes EXP16LAN.EXE from memory.  You must remove TSR programs
  163. in the opposite order they were loaded.  For example, if you loaded
  164. EXP16LAN.EXE and then AILANBIO, you must remove AILANBIO before EXP16LAN.EXE
  165. In addition, if you have more than one invocation of EXP16LAN.EXE and
  166. AILANBIO you must use the MPX= switch on the command line to specify which
  167. copy of EXP16LAN.EXE but not (AILANBIO) that you want to unload.  For
  168. example, if you load two copies of EXP16LAN.EXE and AILANBIO:
  169.  
  170. EXP16LAN.EXE/MPX=C7
  171. AILANBIO/ADAPTER=0/MPX=C7
  172. EXP16LAN.EXE/MPX=D7
  173. AILANBIO/ADAPTER=1/MPX=D7
  174.  
  175. To unload these copies of EXP16LAN.EXE and AILANBIO:
  176.  
  177. AILANBIO/REMOVE
  178. EXP16LAN.EXE/MPX=D7/REMOVE
  179. AILANBIO/REMOVE
  180. EXP16LAN.EXE/MPX=C7/REMOVE
  181.  
  182. The REMOVE option will remove the most recently run copy of AILANBIO.
  183.  
  184. ----------
  185.     VERBOSE
  186.  
  187. This switch causes the EXP16LAN driver to be installed and detailed
  188. information about the configuration of the EXP16LAN driver to be displayed.
  189. See the messages section for a detailed description of the verbose output.
  190.  
  191.  
  192. EXP16LAN messages
  193. =================
  194.  
  195. The EXP16LAN driver produces two types of messages: Informative and Error. 
  196. All error messages are preceded by the text "ERROR:" and cause the EXP16LAN
  197. driver not to be installed.
  198.  
  199. --------
  200. MESSAGE:
  201. AI-LANBIOS EXP16LAN driver Vn.nn - (C) Copyright 1992 ARTISOFT Inc.
  202.  
  203. This message appears each time the low-level driver is invoked.
  204.  
  205. --------
  206. MESSAGE:
  207.            ---- EXP16LAN driver installed ----
  208.  
  209. This message appears after the low-level driver is successfully
  210. installed. 
  211.  
  212. --------
  213. MESSAGE:
  214.          ---- EXP16LAN driver NOT installed ----
  215.  
  216. This message appears if the low-level driver is not installed.  The driver
  217. will not be installed if help information is displayed or an error
  218. occurred.
  219.  
  220. --------
  221. MESSAGE:
  222.  
  223. Command line             /verbose 
  224. IEEE 802.3 node address  02608C4B10CC   Network packet size      1500 
  225. MPX interface number     C7             Machine bus type         PC/XT/AT     
  226. IO base address          0300           Interrupt request (IRQ)  2
  227. Packet type              IEEE 802.3          Transceiver type         ON-BOARD
  228. Bytes of memory used     2160
  229.  
  230. This message appears if the VERBOSE switch is specified.  The values
  231. displayed specify how the low-level driver is configured.  Some values may
  232. not agree with switch values you specified on the command line.  This will
  233. happen when you specify an IOBASE or RAMBASE switch value that is not a
  234. proper multiple of the allowed value.
  235.  
  236. --------
  237. MESSAGE:
  238.  
  239. Valid command line switches:
  240.    HELP
  241.    IOBASE= One of the following choices:
  242.       200 210 220 230 240 250 260 270 
  243.       300 310 320 330 340 350 360 370
  244.    MPX= range C0 to FF hex
  245.    PACKET_SIZE= range 570 to 1500 decimal
  246.    VERBOSE
  247.    ?
  248.    @ range 0 to 2048 byte file
  249.  
  250. This message appears when the HELP or ? switch is used.  Each valid switch
  251. is listed with the acceptable range of values (if any) and the base (hex
  252. or decimal) that the numbers must be entered in.  The acceptable file size
  253. range for indirect files (@) is also listed.  The low-level driver is not
  254. installed when this switch is used.
  255.  
  256. --------
  257. MESSAGE:
  258.  
  259.          ---- EXP16LAN removed ----
  260.  
  261. The EXP16LAN.EXE driver has been removed from memory.
  262.  
  263. --------
  264. ERROR:   EXP16LAN not loaded
  265.  
  266. Meaning: You have issued the EXP16LAN/REMOVE command and do not have
  267.      EXP16LAN.EXE loaded into memory.
  268.  
  269. Remedy:  Only issue this command after the program is loaded.
  270.  
  271. --------
  272. ERROR:   Can't REMOVE -- EXP16LAN interrupts re-hooked
  273.  
  274. Meaning: You have attempted to remove EXP16LAN.EXE and the interrupts are
  275.      in use by another TSR, or EXP16LAN.EXE was not the last TSR
  276.      loaded.
  277.  
  278. Remedy:  Remove any TSRs loaded after EXP16LAN.EXE.  For example, if you
  279.      load EXP16LAN.EXE then AILANBIO.EXE, you must first remove
  280.      AILANBIO.EXE, then you can remove EXP16LAN.EXE.
  281.  
  282. --------
  283. ERROR:   Installed EXP16LAN is different version
  284.  
  285. Meaning: You have loaded a version of the EXP16LAN.EXE program and
  286.      attempted to remove it from memory with the /REMOVE switch.  The
  287.      version with which you are attempting to remove EXP16LAN.EXE is
  288.      not the same version that was loaded.
  289.  
  290. Remedy:  Remove EXP16LAN.EXE with the same version of the program that was
  291.      loaded.
  292.  
  293. --------
  294. ERROR:   MPX number hh is already in use - Try another number
  295.  
  296. Meaning: Multiplex (MPX) interrupt number hh is being used by another
  297.      application or low-level driver.
  298.  
  299. Remedy:  Try another MPX number.
  300.  
  301. --------
  302. ERROR:   No network hardware found at I/O base address ????H
  303.  
  304. Meaning: The EtherExpress 16 hardware could not be located.  This error message
  305.      appears displayed because the adapter card is not present or the
  306.      IOBASE specified on the command line is different from what is
  307.      jumpered on the adapter.
  308.  
  309. Remedy:  Check to see that the IOBASE switch specified on the
  310.      EXP16LAN.EXE command line matches the I/O Address setting contained in
  311.     the EtherExpress board's EEPROM.  To do this, run Intel's SOFTSET 
  312.     program and choose the VIEW CURRENT CONFIGURATION menu.
  313.  
  314. --------
  315. ERROR:   Illegal switch - ??????=nnnn
  316.  
  317. Meaning: The switch ??????=nnnn is not a recognized switch.
  318.  
  319. Remedy:  You may only specify legal switches on the command line.
  320.  
  321. --------
  322. ERROR:   Illegal character after switch name - ??????xnnnn
  323.  
  324. Meaning: The switch ?????? is followed by a character other than "=" or
  325.      ":" or the switch does not take a value.
  326.  
  327. Remedy:  Only use the characters "=" or ":" to specify switch values and
  328.      do not place characters after switches that do not take values.
  329.  
  330. --------
  331. ERROR:   Switch value not in range - ??????=nnnn
  332.      Valid range is ssss to eeee
  333.  
  334. Meaning: The value nnnn is not in proper range.  The value ssss
  335.      represents the lowest acceptable value and the value eeee
  336.      represents the highest acceptable value.
  337.  
  338. Remedy:  Limit your range of values to the acceptable range.
  339.  
  340. --------
  341. ERROR:   Illegal digit in switch value - ??????=nnnn
  342.  
  343. Meaning: An illegal digit (character) was encountered in the numeric
  344.      switch value.
  345.  
  346. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  347.      You must restrict hexadecimal values to the numbers 0-9 and the
  348.      letters A-F.
  349.  
  350. --------
  351. ERROR:   Cannot open indirect file - @file
  352.  
  353. Meaning: The file "file" cannot be opened as an indirect file.
  354.  
  355. Remedy:  The file must exist before it can be used as an indirect file.
  356.  
  357.  
  358. Testing EXP16LAN return code (error level)
  359. ========================================
  360.  
  361. You may test the EXP16LAN return code or error level in a batch file by
  362. using the IF ERRORLEVEL command.  The following error levels are returned:
  363.  
  364.      0     No error has encountered.  EXP16LAN driver installed
  365.      1     MPX number is in use
  366.      2     Switch error
  367.      3     No memory found or memory error
  368.      4     No hardware found or hardware already in use
  369.      6     EXP16LAN not loaded
  370.      7     Can't remove, different version loaded
  371.      8     Cannot remove, interrupts re-hooked
  372.      9     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  373. -------------------
  374.  
  375.  
  376.  
  377.